| class ListenerCenter of a listening space. Attached Sources will be rendered relative to this object's position.| Visibility | Public | | Modifiers | sealed |
Public functionsPublic static functions| string GetLayoutName() | Current speaker layout name in the format of <main>.<LFE>.<height>.<floor>,
or simply "Virtualization". | | implicit operator bool(Listener listener) | Implicit null check. | | void ReplaceChannels(Channel[] channels) | Replace the channel layout. | | void ReplaceChannels(int channelCount) | Replace the channel layout with a standard of a given channel count.
The Listener will set up itself automatically with the user's saved configuration.
The used audio channels can be queried through Channels, which should be respected,
and the output audio channel count should be set to its length. If this is not possible,
the layout could be set to a standard by the number of channels with this function. |
Public properties| IReadOnlyCollection<Source> ActiveSources | Attached Sources. | | QualityModes AudioQuality | Lower qualities increase performance for many sources. | | int DelayTarget | Maximum audio delay, defined in this FPS value. This is the minimum frame rate required to render continuous audio. | | bool DirectLFE | Disable lowpass on the LFE channel. | | bool LFESeparation | Only mix LFE tagged sources to subwoofers. | | float LFEVolume | LFE channels' amplitude multiplier. | | bool LimiterOnly | If active, the normalizer won't increase the volume above 100%. | | int MaximumSources | How many sources can be played at the same time. | | float Normalizer | Adaption speed of the normalizer. 0 means disabled. | | Vector3 Position | Absolute spatial position. | | float Range | Hearing distance. | | Vector3 Rotation | Rotation in Euler angles (degrees). | | int SampleRate | Project sample rate (min. 44100). It's best to have all your audio clips in this sample rate for maximum performance. | | int UpdateRate | Update interval in audio samples (min. 16).
Lower values mean better interpolation, but require more processing power. | | float Volume | Global playback amplitude multiplier. |
Public static properties| Channel[] Channels | Output channel layout. The default setup is the standard 5.1. | | Vector3 EnvironmentSize | The single most important variable defining sound space in symmetric mode, the environment scaling.
Originally set by the user and applied when a Listener is created, however, overriding
it in specific applications can make a huge difference. Objects inside a box this size are positioned
inside the room, and defines the range of balance between left/right, front/rear, and top/bottom speakers.
Does not effect directional rendering. The user's settings should be
respected, thus this vector should be scaled, not completely overridden. | | Environments EnvironmentType | 3D environment type. | | bool HeadphoneVirtualizer | Virtual surround effect for headphones. This will replace the active Channels on the next frame. | | bool IsSpherical | Gets if the speakers are placed in a sphere according to current layout settings. | | bool IsSymmetric | Is the user's speaker layout symmetrical? | | Vector2 ScreenSize | Relative size of the screen to the front wall's width. Used for rendering screen-anchored objects.
The user's settings should be respected, thus this vector should not be overridden without good reason. |
Public variablesSee also| CavernUnity DLL.Cavern.Virtualizer.VirtualizerFilter.Process(float[] output, int sampleRate) | Apply the virtualizer on the Listener's output, if the configuration matches the virtualization layout and filter sample rate. | | CavernUnity DLL.Cavern.Source.Listener listener | The Listener this source is attached to. |
|